Coverage Report

Created: 2024-12-19 06:34

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
D:\a\tools.proto\tools.proto\compiler\src\model\structure.rs
Line
Count
Source
1
// Copyright (c) 2024, BlockProject 3D
2
//
3
// All rights reserved.
4
//
5
// Redistribution and use in source and binary forms, with or without modification,
6
// are permitted provided that the following conditions are met:
7
//
8
//     * Redistributions of source code must retain the above copyright notice,
9
//       this list of conditions and the following disclaimer.
10
//     * Redistributions in binary form must reproduce the above copyright notice,
11
//       this list of conditions and the following disclaimer in the documentation
12
//       and/or other materials provided with the distribution.
13
//     * Neither the name of BlockProject 3D nor the names of its contributors
14
//       may be used to endorse or promote products derived from this software
15
//       without specific prior written permission.
16
//
17
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29
use crate::model::protocol::Description;
30
use serde::Deserialize;
31
32
#[derive(Clone, Debug, Deserialize)]
33
#[serde(rename_all = "snake_case")]
34
#[serde(tag = "type")]
35
pub enum StructFieldView {
36
    Enum { name: String },
37
    FloatRange { min: f64, max: f64 },
38
    FloatMultiplier { multiplier: f64 },
39
}
40
41
#[derive(Clone, Debug, Deserialize)]
42
#[serde(rename_all = "snake_case")]
43
#[serde(tag = "type")]
44
pub enum StructFieldRaw {
45
    Signed { bits: usize },
46
    Unsigned { bits: usize },
47
    Float { bits: usize },
48
    Boolean { bits: usize },
49
}
50
51
#[derive(Clone, Debug, PartialEq, Eq)]
52
pub enum SimpleType {
53
    Signed,
54
    Unsigned,
55
    Float,
56
    Boolean,
57
    Struct,
58
}
59
60
impl StructFieldRaw {
61
483
    pub fn get_simple_type(&self) -> SimpleType {
62
483
        match self {
63
81
            StructFieldRaw::Signed { .. } => SimpleType::Signed,
64
322
            StructFieldRaw::Unsigned { .. } => SimpleType::Unsigned,
65
44
            StructFieldRaw::Float { .. } => SimpleType::Float,
66
36
            StructFieldRaw::Boolean { .. } => SimpleType::Boolean,
67
        }
68
483
    }
69
70
370
    pub fn get_bit_size(&self) -> usize {
71
370
        match self {
72
55
            StructFieldRaw::Signed { bits } => *bits,
73
261
            StructFieldRaw::Unsigned { bits } => *bits,
74
30
            StructFieldRaw::Float { bits } => *bits,
75
24
            StructFieldRaw::Boolean { bits } => *bits,
76
        }
77
370
    }
78
}
79
80
#[derive(Clone, Debug, Deserialize)]
81
pub struct Offset {
82
    pub relative_to: Option<String>,
83
    pub bits: Option<usize>,
84
}
85
86
#[derive(Clone, Debug, Deserialize)]
87
pub struct StructField {
88
    pub name: String,
89
    pub description: Option<Description>,
90
    pub raw: Option<StructFieldRaw>,
91
    pub view: Option<StructFieldView>,
92
    pub array_len: Option<usize>,
93
    pub item_type: Option<String>,
94
    pub offset: Option<Offset>,
95
}
96
97
#[derive(Clone, Debug, Deserialize)]
98
pub struct Structure {
99
    pub name: String,
100
    pub description: Option<Description>,
101
    pub fields: Vec<StructField>,
102
}